/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.persistence.basis.criteria;

import java.util.HashMap;
import java.util.Map;

import com.genia.toolbox.persistence.criteria.CriteriaResult;
import com.genia.toolbox.persistence.criteria.CriteriaType;

/**
 * This class is the basis implementation of <code>CriteriaResult</code> that
 * represents a line of result from a criteria.
 * 
 * @param <MAINTYPE>
 *          The main type of the criteria that generated this result
 */
@SuppressWarnings("serial")
public class BasicCriteriaResult<MAINTYPE>
    extends HashMap<CriteriaType<?>, Object>
    implements CriteriaResult<MAINTYPE>
{

  /**
   * the <code>CriteriaType</code> representing the main type of this result.
   */
  private transient final CriteriaType<MAINTYPE> mainType;



  /**
   * construct a new empty BasicCriteriaResult.
   * 
   * @param mainType
   *          the class of the main type of the created
   *          <code>BasicCriteriaResult</code>
   */
  public BasicCriteriaResult(final CriteriaType<MAINTYPE> mainType)
  {
    this(mainType, new HashMap<CriteriaType<?>, Object>());
  }



  /**
   * construct a new BasicCriteriaResult with the content of <code>result</code>.
   * 
   * @param mainType
   *          the class of the main type of the created
   *          <code>BasicCriteriaResult</code>
   * @param results
   *          the content of the created <code>BasicCriteriaResult</code>
   */
  public BasicCriteriaResult(final CriteriaType<MAINTYPE> mainType, final Map<CriteriaType<?>, Object> results)
  {
    super(results);
    this.mainType = mainType;
  }



  /**
   * Return the column that represents the main type of this result.
   * 
   * @return the value of this result on the column of the main type of this
   *         result.
   */
  public MAINTYPE get()
  {
    return get(mainType);
  }



  /**
   * Return the column represented by <code>criteriaType</code> of this line.
   * 
   * @param <TYPE>
   *          the type of the result.
   * @param criteriaType
   *          the column to retrieve.
   * @return the value of this result on the column passed as argument.
   */
  @SuppressWarnings("unchecked")
  public <TYPE> TYPE get(final CriteriaType<TYPE> criteriaType)
  {
    return (TYPE) super.get(criteriaType);
  }

}
